public interface CiscoAddress extends javax.telephony.Address, CiscoObjectContainer
The CiscoAddress
interface extends the Address interface with additional
Cisco-specific capabilities.
Address
Modifier and Type | Field and Description |
---|---|
static int |
APPLICATION_CONTROLLED_RECORDING
Deprecated.
Please use CiscoAddress.SELECTIVE_RECORDING
|
static int |
AUTO_RECORDING |
static int |
AUTOACCEPT_OFF
AutoAccept is off.
|
static int |
AUTOACCEPT_ON
AutoAccept is on.
|
static int |
AUTOANSWER_OFF
AutoAnswer is off.
|
static int |
AUTOANSWER_UNKNOWN
AutoAnswer status is unknown.
|
static int |
AUTOANSWER_WITHHEADSET
AutoAnswer is allowed with a headset.
|
static int |
AUTOANSWER_WITHSPEAKERSET
AutoAnswer is allowed with a speaker set.
|
static int |
DEVICE_CONTROLLED_RECORDING
Deprecated.
Please use CiscoAddress.SELECTIVE_RECORDING
|
static int |
EXTERNAL
This represents an external address with a valid name.
|
static int |
EXTERNAL_UNKNOWN
This represents an external address with an unknown name.
|
static int |
HUNT_PILOT
This type indicates that the address represents a Hunt Pilot.
|
static int |
IN_SERVICE
The address is in service.
|
static int |
INTERNAL
This is an internal address.
|
static int |
MONITORING_TARGET
This represents an address with a monitoring target or agent.
|
static int |
NO_RECORDING
Recording is off on the Address.
|
static int |
OUT_OF_SERVICE
The address is out-of-service.
|
static int |
RINGER_DEFAULT
Sets the ringer status to the configured value.
|
static int |
RINGER_DISABLE
Disables the ringer for the address.
|
static int |
RINGER_ENABLE
Enables the ringer for the address.
|
static int |
SELECTIVE_RECORDING
Selective Recording is configured on the Address.
|
static int |
UNKNOWN
This represents an address with an unknown name.
|
Modifier and Type | Method and Description |
---|---|
void |
clearCallConnections()
Use this interface to clear any phantom calls on the address.
|
CiscoCall |
createPersistentCall(javax.telephony.Terminal terminal,
java.lang.String callerIDNumber,
java.lang.String callerIDName)
Creates a Persistent Call for this Address.
|
CiscoAddressCallInfo |
getAddressCallInfo(javax.telephony.Terminal terminal)
Use this Interface to get information about calls that are present at the Terminal.
|
java.lang.String |
getAsciiLabel(javax.telephony.Terminal term)
Returns the configured 'ASCII Line Text Label' of this address on Terminal term
|
int |
getAutoAcceptStatus(javax.telephony.Terminal terminal)
Returns the AutoAccept status of the Address on the Terminal.
|
int |
getAutoAnswerStatus(javax.telephony.Terminal term)
This interface returns the AutoAnswer status of this Address on given Terminal.
|
int |
getBusyTrigger(javax.telephony.Terminal term)
Returns the busy trigger configured on this address on Terminal term
|
int |
getButtonPosition(javax.telephony.Terminal term)
Returns the position of this address on Terminal term
|
CiscoAddrEvFilter |
getFilter()
Retrieves the filter object associated with the address.
|
javax.telephony.Terminal[] |
getInServiceAddrTerminals()
Use this interface to find out which Shared Lines are in service.
|
int |
getMaxCalls(javax.telephony.Terminal term)
Returns the max calls configured on this address on Terminal term
|
java.lang.String |
getPartition()
It returns the partition associated with an Address.
|
javax.telephony.Connection |
getPersistentConnection(javax.telephony.Terminal terminal)
Returns the Connection object for this Address' Persistent Connection if one is set up,
or null if no Persistent Connection is created for this Address.
|
CiscoPickupGroup |
getPickupGroup()
Retrieves the Pickup Group that this Address belongs to.
|
int |
getRecordingConfig(javax.telephony.Terminal term)
Returns the configured recording type on this Address.
|
int |
getRegistrationState()
Deprecated.
This method has been replaced by the getState() method.
|
javax.telephony.Terminal[] |
getRestrictedAddrTerminals()
Returns the array of Terminals on which this Address is restricted.
|
int |
getState()
Returns the state of this address.
|
int |
getType()
Returns the type of this address.
|
java.lang.String |
getUnicodeLabel(javax.telephony.Terminal term)
Returns the configured 'Line Text Label' of this address on Terminal term
|
java.lang.String |
getVoiceMailPilot()
Returns the Voice Mail Pilot of the address
|
boolean |
isRestricted(javax.telephony.Terminal terminal)
This method returns true if this Address on Terminal is restricted.
|
void |
setAutoAcceptStatus(int autoAcceptStatus,
javax.telephony.Terminal terminal)
This method lets an application enable AutoAccept for this Address on CiscoMediaTerminal
and/or CiscoRouteTerminal.
|
void |
setFilter(CiscoAddrEvFilter addrFilter)
Filters the events that get delivered to the AddressObserver.
|
void |
setMessageSummary(boolean enable,
boolean voiceCounts,
int totalNewVoiceMsgs,
int totalOldVoiceMsgs,
boolean highPriorityVoiceCounts,
int newHighPriorityVoiceMsgs,
int oldHighPriorityVoiceMsgs,
boolean faxCounts,
int totalNewFaxMsgs,
int totalOldFaxMsgs,
boolean highPriorityFaxCounts,
int newHighPriorityFaxMsgs,
int oldHighPriorityFaxMsgs)
Use this interface to set the message-waiting indicator along with voice/fax message waiting
counts If
enable is true, message-waiting gets activated if not already
activated. |
void |
setMessageSummary(java.lang.String destination,
boolean enable,
boolean voiceCounts,
int totalNewVoiceMsgs,
int totalOldVoiceMsgs,
boolean highPriorityVoiceCounts,
int newHighPriorityVoiceMsgs,
int oldHighPriorityVoiceMsgs,
boolean faxCounts,
int totalNewFaxMsgs,
int totalOldFaxMsgs,
boolean highPriorityFaxCounts,
int newHighPriorityFaxMsgs,
int oldHighPriorityFaxMsgs)
Use this interface to set the message-waiting indicator along with voice/fax message waiting
counts for the Address specified by the
destination . |
void |
setMessageWaiting(java.lang.String destination,
boolean enable)
Specifies whether the message-waiting indicator should be activated or deactivated for the
Address specified by the
destination . |
void |
setRingerStatus(int status)
Changes the ringer status on this address.
|
CiscoCall |
startAnnouncement(javax.telephony.Terminal terminal,
java.lang.String announcementID)
Starts the announcement.
|
addCallObserver, addObserver, getAddressCapabilities, getCallObservers, getCapabilities, getConnections, getName, getObservers, getProvider, getTerminals, removeCallObserver, removeObserver
getObject, setObject
static final int INTERNAL
static final int EXTERNAL
static final int EXTERNAL_UNKNOWN
static final int UNKNOWN
static final int MONITORING_TARGET
static final int HUNT_PILOT
static final int OUT_OF_SERVICE
static final int IN_SERVICE
static final int RINGER_DEFAULT
static final int RINGER_DISABLE
static final int RINGER_ENABLE
static final int AUTOACCEPT_OFF
static final int AUTOACCEPT_ON
static final int AUTOANSWER_OFF
static final int AUTOANSWER_WITHHEADSET
static final int AUTOANSWER_WITHSPEAKERSET
static final int AUTOANSWER_UNKNOWN
static final int NO_RECORDING
static final int AUTO_RECORDING
static final int APPLICATION_CONTROLLED_RECORDING
static final int DEVICE_CONTROLLED_RECORDING
static final int SELECTIVE_RECORDING
int getType()
int getRegistrationState()
The state may be any of the following constants:
int getState()
The state may be any of the following constants:
void setRingerStatus(int status) throws javax.telephony.MethodNotSupportedException, javax.telephony.InvalidStateException, javax.telephony.InvalidArgumentException
javax.telephony.MethodNotSupportedException
javax.telephony.InvalidStateException
javax.telephony.InvalidArgumentException
void clearCallConnections() throws javax.telephony.PrivilegeViolationException
javax.telephony.PrivilegeViolationException
CiscoAddressCallInfo getAddressCallInfo(javax.telephony.Terminal terminal)
void setMessageWaiting(java.lang.String destination, boolean enable) throws javax.telephony.MethodNotSupportedException, javax.telephony.InvalidStateException, javax.telephony.PrivilegeViolationException
destination
. If enable
is true,
message-waiting gets activated if not already activated. If enable
is false,
message-waiting gets deactivated if not already deactivated.
Pre-conditions:
destination
- DN/Address whose message-waiting indicator should be activated/deactivatedenable
- True to activate message-waiting, false to deactivatejavax.telephony.MethodNotSupportedException
- This method is not supported by the given implementation.javax.telephony.InvalidStateException
- The Provider is not "in service."javax.telephony.PrivilegeViolationException
- The Provider user has insufficient privileges to invoke the message-waiting
indicator for this destination.void setMessageSummary(java.lang.String destination, boolean enable, boolean voiceCounts, int totalNewVoiceMsgs, int totalOldVoiceMsgs, boolean highPriorityVoiceCounts, int newHighPriorityVoiceMsgs, int oldHighPriorityVoiceMsgs, boolean faxCounts, int totalNewFaxMsgs, int totalOldFaxMsgs, boolean highPriorityFaxCounts, int newHighPriorityFaxMsgs, int oldHighPriorityFaxMsgs) throws javax.telephony.MethodNotSupportedException, javax.telephony.InvalidStateException, javax.telephony.PrivilegeViolationException
destination
. If enable
is
true, message-waiting gets activated if not already activated. If enable
is
false, message-waiting gets deactivated if not already deactivated.
Pre-conditions:
destination
- DN/Address whose message-waiting indicator should be activated/deactivatedenable
- True to activate message-waiting, false to deactivatevoiceCounts
- indicates if voice message counts are providedtotalNewVoiceMsgs
- specifies the total number of new voice messages waitingtotalOldVoiceMsgs
- specifies the total number of old voice messages waitinghighPriorityVoiceCounts
- indicates if high priority voice message counts are providednewHighPriorityVoiceMsgs
- specifies the number of new high priority voice messages waitingoldHighPriorityVoiceMsgs
- specifies the number of old high priority voice messages waitingfaxCounts
- indicates if fax message counts are providedtotalNewFaxMsgs
- specifies the total number of new fax messages waitingtotalOldFaxMsgs
- specifies the total number of old fax messages waitinghighPriorityFaxCounts
- indicates if high priority fax message counts are providednewHighPriorityFaxMsgs
- specifies the number of new high priority fax messages waitingoldHighPriorityFaxMsgs
- specifies the number of old high priority fax messages waitingjavax.telephony.MethodNotSupportedException
- This method is not supported by the given implementation.javax.telephony.InvalidStateException
- The Provider is not "in service."javax.telephony.PrivilegeViolationException
- The Provider user has insufficient privileges to set the message-waiting
indicator or message counts for this destination.void setMessageSummary(boolean enable, boolean voiceCounts, int totalNewVoiceMsgs, int totalOldVoiceMsgs, boolean highPriorityVoiceCounts, int newHighPriorityVoiceMsgs, int oldHighPriorityVoiceMsgs, boolean faxCounts, int totalNewFaxMsgs, int totalOldFaxMsgs, boolean highPriorityFaxCounts, int newHighPriorityFaxMsgs, int oldHighPriorityFaxMsgs) throws javax.telephony.MethodNotSupportedException, javax.telephony.InvalidStateException, javax.telephony.PrivilegeViolationException
enable
is true, message-waiting gets activated if not already
activated. If enable
is false, message-waiting gets deactivated if not already
deactivated.
Pre-conditions:
enable
- True to activate message-waiting, false to deactivatevoiceCounts
- indicates if voice message counts are providedtotalNewVoiceMsgs
- specifies the total number of new voice messages waitingtotalOldVoiceMsgs
- specifies the total number of old voice messages waitinghighPriorityVoiceCounts
- indicates if high priority voice message counts are providednewHighPriorityVoiceMsgs
- specifies the number of new high priority voice messages waitingoldHighPriorityVoiceMsgs
- specifies the number of old high priority voice messages waitingfaxCounts
- indicates if fax message counts are providedtotalNewFaxMsgs
- specifies the total number of new fax messages waitingtotalOldFaxMsgs
- specifies the total number of old fax messages waitinghighPriorityFaxCounts
- indicates if high priority fax message counts are providednewHighPriorityFaxMsgs
- specifies the number of new high priority fax messages waitingoldHighPriorityFaxMsgs
- specifies the number of old high priority fax messages waitingjavax.telephony.MethodNotSupportedException
- This method is not supported by the given implementation.javax.telephony.InvalidStateException
- The Provider is not "in service."javax.telephony.PrivilegeViolationException
- The Provider user has insufficient privileges to set the message-waiting
indicator or message counts for this destination.javax.telephony.Terminal[] getInServiceAddrTerminals()
javax.telephony.Terminal[] getRestrictedAddrTerminals()
Returns the array of Terminals on which this Address is restricted.
In shared lines, few lines on Terminals may be restricted. This method returns all the Terminals on which this Address is restricted. Applications will not be able to see any call events for restricted Addresses. If a restricted Address is involved in a call with any other controlled Terminal, the system creates an Connection for the restricted Address, but there will not be any TerminalConnection for the restricted Address.
If none is restricted, this method returns null.
boolean isRestricted(javax.telephony.Terminal terminal)
This method returns true if this Address on Terminal is restricted.
void setAutoAcceptStatus(int autoAcceptStatus, javax.telephony.Terminal terminal) throws javax.telephony.PlatformException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException
Pre-conditions:
autoAcceptStatus
- can be either CiscoAddress.AUTOACCEPT_OFF or CiscoAddress.AUTOACCEPT_ON. If
autoAcceptStatus is AUTOACCEPT_ON, it will enable AutoAccept for Address on
Terminal. If autoAcceptStatus is AUTOACCEPT_OFF, it will disable AutoAccept for
Address on Terminal.terminal
- The Terminal on which AutoAccept will be enabledjavax.telephony.InvalidStateException
- The Provider or Address is not "In_Service".javax.telephony.PlatformException
- The Terminal does not have this Address.javax.telephony.MethodNotSupportedException
- If the Terminal is not CiscoMediaTerminal or CiscoRouteTerminal.int getAutoAcceptStatus(javax.telephony.Terminal terminal) throws javax.telephony.PlatformException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException
Pre-conditions:
terminal
- The Terminal on which the AutoAccept status of the Address will be returnedjavax.telephony.InvalidStateException
- The Provider or Address is not "IN_SERVICE".javax.telephony.PlatformException
- The Address is not on the Terminal.javax.telephony.MethodNotSupportedException
- If the Terminal is not CiscoMediaTerminal or CiscoRouteTerminal.java.lang.String getPartition()
int getAutoAnswerStatus(javax.telephony.Terminal term) throws javax.telephony.PlatformException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException
This interface returns the AutoAnswer status of this Address on given Terminal. If return value is AUTOANSWER_OFF, that means AutoAnswer is disabled. If return value is AUTOANSWER_WITHHEADSET, that means AutoAnswer is enabled with HEADSET. If return value is AUTOANSWER_WITHSPEAKERSET, that means AutoAnswer is enabled with SPEAKERSET. If return value is AUTOANSWER_UNKNOWN, that means AutoAnswer status is UNKNOWN.
Pre-conditions:
term
- Terminal at which AutoAnswer is checkedjavax.telephony.InvalidStateException
- The Provider or Address is not"IN_SERVICE".javax.telephony.PlatformException
- If Address is not on Terminal termjavax.telephony.MethodNotSupportedException
- If Address is an External Addressint getRecordingConfig(javax.telephony.Terminal term) throws javax.telephony.PlatformException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException
javax.telephony.InvalidStateException
- The Provider or Address is not"IN_SERVICE".javax.telephony.PlatformException
- If Address is not on Terminal termjavax.telephony.MethodNotSupportedException
- If Address is an External Addressvoid setFilter(CiscoAddrEvFilter addrFilter)
CiscoAddrEvFilter getFilter()
CiscoPickupGroup getPickupGroup()
CiscoPickupGroup
objectint getMaxCalls(javax.telephony.Terminal term) throws javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidArgumentException
javax.telephony.InvalidStateException
- The Terminal specified is not registeredjavax.telephony.MethodNotSupportedException
- The address is not in this provider's domainjavax.telephony.InvalidArgumentException
- The Terminal term doesn't have this addressint getBusyTrigger(javax.telephony.Terminal term) throws javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidArgumentException
javax.telephony.InvalidStateException
- The Terminal specified is not registeredjavax.telephony.MethodNotSupportedException
- The address is not in this provider's domainjavax.telephony.InvalidArgumentException
- The Terminal term doesn't have this addressint getButtonPosition(javax.telephony.Terminal term) throws javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidArgumentException
javax.telephony.InvalidStateException
- The Terminal specified is not registeredjavax.telephony.MethodNotSupportedException
- The address is not in this provider's domainjavax.telephony.InvalidArgumentException
- The Terminal term doesn't have this addressjava.lang.String getVoiceMailPilot() throws javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException
javax.telephony.InvalidStateException
- Provider is not in-Servicejavax.telephony.MethodNotSupportedException
- The address is not in this provider's domainjava.lang.String getAsciiLabel(javax.telephony.Terminal term) throws javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidArgumentException
javax.telephony.InvalidStateException
- The Terminal specified is not registeredjavax.telephony.MethodNotSupportedException
- The address is not in this provider's domainjavax.telephony.InvalidArgumentException
- The Terminal term doesn't have this addressjava.lang.String getUnicodeLabel(javax.telephony.Terminal term) throws javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException, javax.telephony.InvalidArgumentException
javax.telephony.InvalidStateException
- The Terminal specified is not registeredjavax.telephony.MethodNotSupportedException
- The address is not in this provider's domainjavax.telephony.InvalidArgumentException
- The Terminal term doesn't have this addressCiscoCall createPersistentCall(javax.telephony.Terminal terminal, java.lang.String callerIDNumber, java.lang.String callerIDName) throws javax.telephony.PlatformException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException, javax.telephony.ResourceUnavailableException
terminal
- The terminal object you want to create the Persistent Connection call for.callerIDNumber
- The number you wish to show up on the remote destination's Caller IDcallerIDName
- The name you wish to show up on the remote destination's Caller IDjavax.telephony.PlatformException
javax.telephony.InvalidStateException
javax.telephony.MethodNotSupportedException
javax.telephony.ResourceUnavailableException
javax.telephony.Connection getPersistentConnection(javax.telephony.Terminal terminal) throws javax.telephony.MethodNotSupportedException
terminal
- The terminal object you want to get the Persistent Connection for.javax.telephony.MethodNotSupportedException
CiscoCall startAnnouncement(javax.telephony.Terminal terminal, java.lang.String announcementID) throws javax.telephony.PlatformException, javax.telephony.InvalidStateException, javax.telephony.MethodNotSupportedException, javax.telephony.ResourceUnavailableException
terminal
- The terminal object you want to start the play announcement on.announcementID
- The announcement identifier.javax.telephony.PlatformException
javax.telephony.InvalidStateException
javax.telephony.MethodNotSupportedException
javax.telephony.ResourceUnavailableException